home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Xm
/
XmClipboardInquireFormat.z
/
XmClipboardInquireFormat
Wrap
Text File
|
1998-10-30
|
6KB
|
133 lines
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
NNNNAAAAMMMMEEEE
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt - A clipboard function that returns
a specified format name
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
#include <Xm/CutPaste.h>
int XmClipboardInquireFormat (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_n_d_e_x, _f_o_r_m_a_t__n_a_m_e__b_u_f,
_b_u_f_f_e_r__l_e_n, _c_o_p_i_e_d__l_e_n)
Display * _d_i_s_p_l_a_y;
Window _w_i_n_d_o_w;
int _i_n_d_e_x;
XtPointer _f_o_r_m_a_t__n_a_m_e__b_u_f;
unsigned long _b_u_f_f_e_r__l_e_n;
unsigned long * _c_o_p_i_e_d__l_e_n;
(vvvvooooiiiidddd)
VVVVEEEERRRRSSSSIIIIOOOONNNN
This page documents Motif 2.1.
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt returns a specified format name for
the data item in the clipboard. If the name must be
truncated, the function returns a warning status.
_d_i_s_p_l_a_y Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
XXXXttttDDDDiiiissssppppllllaaaayyyy.
_w_i_n_d_o_w Specifies the window ID of a widget that relates
the application window to the clipboard. The
widget's window ID can be obtained through
XXXXttttWWWWiiiinnnnddddoooowwww. The same application instance should
pass the same window ID to each of the clipboard
functions that it calls.
_i_n_d_e_x Specifies which of the ordered format names to
obtain. If this index is greater than the number
of formats for the data item, this function
returns a 0 (zero) in the _c_o_p_i_e_d__l_e_n argument.
_f_o_r_m_a_t__n_a_m_e__b_u_f
Specifies the buffer that receives the format
name.
_b_u_f_f_e_r__l_e_n
Specifies the number of bytes in the format name
buffer.
_c_o_p_i_e_d__l_e_n
Specifies the number of bytes in the data item
copied to the buffer. If this argument equals 0
(zero), there is no _nth format for the data item.
Page 1 (printed 10/24/98)
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
RRRREEEETTTTUUUURRRRNNNN
_X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
The function was successful.
_X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
The function failed because the clipboard was
locked by another application. The application can
continue to call the function again with the same
parameters until the lock goes away. This gives
the application the opportunity to ask if the user
wants to keep trying or to give up on the
operation.
_X_m_C_l_i_p_b_o_a_r_d_T_r_u_n_c_a_t_e
The data returned is truncated because the user
did not provide a buffer large enough to hold the
data.
_X_m_C_l_i_p_b_o_a_r_d_N_o_D_a_t_a
The function could not find data on the clipboard
corresponding to the format requested. This could
occur because the clipboard is empty; there is
data on the clipboard, but not in the requested
format; or the data in the requested format was
passed by name and is no longer available.
RRRREEEELLLLAAAATTTTEEEEDDDD
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
Page 2 (printed 10/24/98)